/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache license, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.internna.iwebjtracker.server.scm.model;

import java.io.InputStream;

/**
 * SCM item contents.
 *
 * @author Jose Noheda
 * @since 1.0
 */
public interface ItemData {

    /**
     * Determines if this item data is text (plain, HTMl, XML,...)
     *
     * @return true if the data is readable.
     */
    boolean isASCII();

    /**
     * Basically not readable data.
     *
     * @return !isASCII()
     */
    boolean isBinary();

    /**
     * Returns the content retrieved from the SCM server as a String
     *
     * @return null if isBinary(). Otherwise the file contents.
     */
    String getReadableContent();

    /**
     * Returns file contents in a machine readable format.
     *
     * @return A non null pointer to read the bytes.
     */
    InputStream getBinaryData();

}
